kanzi::Trigger Class Reference

Trigger is the base class for defining events, conditions and actions for content-driven logic programming. More...

#include <kanzi/core.ui/trigger/trigger.hpp>

Inheritance diagram for kanzi::Trigger:

Public Types
typedef vector< ActionSharedPtr >	ActionContainer
typedef ActionContainer::const_iterator	ActionIterator
typedef vector< ConditionSharedPtr >	ConditionContainer
typedef ConditionContainer::const_iterator	ConditionIterator
Public Types inherited from kanzi::NodeComponent
using	NodeComponentMessageArguments
	Legacy name for NodeComponentTargetMessageArguments.
enum	State { StateDetached , StateDetaching , StateAttaching , StateAttached }
	State indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More...
Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator
typedef vector< PropertyStoragePtr >	PropertyStorageContainer
typedef PropertyStorageContainer::iterator	PropertyStorageIterator
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr
typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
void	addAction (ActionSharedPtr action)
	Adds an action to the trigger.
void	addCondition (ConditionSharedPtr condition)
	Adds a condition to the trigger.
ActionIterator	beginActions () const
ConditionIterator	beginConditions () const
bool	checkConditions () const
	Checks against all conditions in the trigger.
ActionIterator	endActions () const
ConditionIterator	endConditions () const
void	invokeActions () const
	Invokes actions in the trigger.
Public Member Functions inherited from kanzi::NodeComponent
void	attach (NodeWeakPtr node)
	Attaches node component to node.
void	detach ()
	Detaches node component from the node it was attached to.
string	getName () const
	Gets the name of node component.
NodeSharedPtr	getNode () const
	Returns the node the node component is attached to or null pointer if node component is not attached to a node.
State	getState () const
	Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching.
bool	isAttached () const
	Indicates whether node component is attached to a node.
bool	isAttaching () const
	Indicates whether node component is in the process of attaching to a node.
bool	isAttachingOrAttached () const
	Indicates whether node component is in the process of attaching to a node or already attached.
bool	isDetached () const
	Indicates whether node component is detached from any node.
bool	isDetaching () const
	Indicates whether node component currently detaching from the node.
bool	isDetachingOrDetached () const
	Indicates whether node component is in the process of detaching from the node or already detached.
void	setName (string_view name)
	Sets the name of node component.
	~NodeComponent () override
	Destructor.
Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.
void	applyObjectStyles ()
	Apply all styles for an object node.
Domain *	getDomain () const
	Returns the domain the object belongs to.
const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.
MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.
detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.
ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.
ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.
	Object (Domain *domain)
void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.
void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.
	~Object () override
Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.
virtual	~MetaObject ()
Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.
template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.
PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.
void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.
void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.
PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.
PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.
template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.
bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.
bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.
bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.
bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.
bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.
	PropertyObject ()
void	removeKzbProperties ()
	Remove all KZB properties.
void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.
template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.
template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.
void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.
void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.
virtual	~PropertyObject ()

Protected Member Functions
void	attachOverride () override
	NodeComponent::attachOverride() implementation.
void	detachOverride () override
	NodeComponent::detachOverride() implementation.
	Trigger (Domain *domain, string_view name)
Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType , typename TClass , typename TMethod >
Node::MessageSubscriptionToken	addNodeComponentMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TMethod method)
	Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of this node component, or if the message is broadcast to all node components with an empty target name.
template<typename TMessageType >
Node::MessageSubscriptionToken	addNodeComponentMessageHandler (TMessageType &messageType, typename TMessageType::FunctionType function)
	Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name.
void	dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
	Adds the name of the node component to the abstract message arguments and dispatches the message to the node of the node component.
template<typename TArgumentsType >
void	dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
	Adds the name of the node component to the message arguments and dispatches the message to the node of the node component.
	NodeComponent (Domain *domain, string_view name)
	Constructor.
void	removeNodeComponentMessageFilter (Node::MessageSubscriptionToken subscriptionToken)
	Removes message handler added via addNodeComponentMessageHandler function.
Protected Member Functions inherited from kanzi::Object
void	initialize ()
void	onCopy (const Object &other)
Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()
	MetaObject ()
Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.
AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
	Internally adds a property value source.
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
	Internally adds a property value source.
AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.
AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.
PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.
virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.
void	onCopy (const PropertyObject &other)
void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.
void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
	Removes a property value source.
void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.
void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Static Protected Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
Static Protected Member Functions inherited from kanzi::NodeComponent
template<typename TMessageType >
static void	nodeComponentMessageHandler (const NodeComponent *nodeComponent, const typename TMessageType::FunctionType &function, typename TMessageType::ArgumentsType &messageArguments)
	Handler function for node component messages.

Properties
static PropertyType< void * >	ForwardedMessageProperty
	ForwardedMessage property.
void *	getForwardedMessage () const
	Gets the value of ForwardedMessageProperty.
void	setForwardedMessage (void *value)
	Sets the value of ForwardedMessageProperty.

Additional Inherited Members
Static Public Member Functions inherited from kanzi::NodeComponent
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.
Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.
Static Public Attributes inherited from kanzi::NodeComponent
static PropertyType< string >	NameProperty
	Name property specifies the name of node component.
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Detailed Description

Trigger is the base class for defining events, conditions and actions for content-driven logic programming.

Member Typedef Documentation

ActionContainer

typedef vector<ActionSharedPtr> kanzi::Trigger::ActionContainer

ActionIterator

typedef ActionContainer::const_iterator kanzi::Trigger::ActionIterator

ConditionContainer

typedef vector<ConditionSharedPtr> kanzi::Trigger::ConditionContainer

ConditionIterator

typedef ConditionContainer::const_iterator kanzi::Trigger::ConditionIterator

Constructor & Destructor Documentation

Trigger()

kanzi::Trigger::Trigger ( Domain * domain, string_view name )

explicitprotected

Member Function Documentation

getForwardedMessage()

void * kanzi::Trigger::getForwardedMessage ( ) const

inline

Gets the value of ForwardedMessageProperty.

See also

setForwardedMessage()

setForwardedMessage()

void kanzi::Trigger::setForwardedMessage ( void * value )

inline

Sets the value of ForwardedMessageProperty.

See also

getForwardedMessage()

addAction()

void kanzi::Trigger::addAction

(

ActionSharedPtr

action

)

Adds an action to the trigger.

invokeActions()

void kanzi::Trigger::invokeActions

(

)

const

Invokes actions in the trigger.

beginActions()

ActionIterator kanzi::Trigger::beginActions

(

)

const

endActions()

ActionIterator kanzi::Trigger::endActions

(

)

const

addCondition()

void kanzi::Trigger::addCondition

(

ConditionSharedPtr

condition

)

Adds a condition to the trigger.

checkConditions()

bool kanzi::Trigger::checkConditions

(

)

const

Checks against all conditions in the trigger.

beginConditions()

ConditionIterator kanzi::Trigger::beginConditions

(

)

const

endConditions()

ConditionIterator kanzi::Trigger::endConditions

(

)

const

attachOverride()

void kanzi::Trigger::attachOverride ( )

overrideprotectedvirtual

NodeComponent::attachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

detachOverride()

void kanzi::Trigger::detachOverride ( )

overrideprotectedvirtual

NodeComponent::detachOverride() implementation.

Reimplemented from kanzi::NodeComponent.

makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::Trigger::makeEditorInfo ( )

staticprotected

Member Data Documentation

ForwardedMessageProperty

PropertyType<void*> kanzi::Trigger::ForwardedMessageProperty

static

ForwardedMessage property.

The default value is 0.

See also

setForwardedMessage(), getForwardedMessage()

---

The documentation for this class was generated from the following file:

• kanzi/core.ui/trigger/trigger.hpp